<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>bitfieldExtract - OpenGL ES 3.1 Reference Pages</title>
    <link rel="stylesheet" type="text/css" href="opengl-man.css"/>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
    <script type="text/x-mathjax-config">
            MathJax.Hub.Config({
                MathML: {
                    extensions: ["content-mathml.js"]
                },
                tex2jax: {
                    inlineMath: [['$','$'], ['\\(','\\)']]
                }
            });
        </script>
    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
  </head>
  <body>
    <header/>
    <div class="refentry" id="bitfieldExtract">
      <div class="titlepage"/>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>bitfieldExtract — extract a range of bits from an integer</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>Declaration</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">genIType <strong class="fsfunc">bitfieldExtract</strong>(</code>
              </td>
              <td>genIType <var class="pdparam">value</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">offset</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">bits</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">genUType <strong class="fsfunc">bitfieldExtract</strong>(</code>
              </td>
              <td>genUType <var class="pdparam">value</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">offset</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>int <var class="pdparam">bits</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>value</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the integer from which to extract bits.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>offset</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the index of the first bit to extract.
                </p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>bits</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>
                    Specifies the number of bits to extract.
                </p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p>
            <code class="function">bitfieldExtract</code> extracts a subset of the bits of <em class="parameter"><code>value</code></em> and returns
            it in the least significant bits of the result. The range of bits extracted is [<em class="parameter"><code>offset</code></em>, <em class="parameter"><code>offset</code></em> + <em class="parameter"><code>bits</code></em> - 1].
        </p>
        <p>
            For unsigned data types, the most significant bits of the result will be set to zero. For signed data types, the most significant bits will be set to the value of
            bit <em class="parameter"><code>offset</code></em> + <em class="parameter"><code>base</code></em> - 1 (i.e., it is <span class="emphasis"><em>sign extended</em></span> to the width of the return type).
        </p>
        <p>
            If <em class="parameter"><code>bits</code></em> is zero, the result will be zero. The result will be undefined if <em class="parameter"><code>offset</code></em> or <em class="parameter"><code>bits</code></em> is negative,
            or if the sum of <em class="parameter"><code>offset</code></em> and <em class="parameter"><code>bits</code></em> is greater than the number of bits used to store the operand.
        </p>
      </div>
      <div class="refsect1" id="versions">
        <h2>Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; "/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">
                 
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="3">
                <span class="bold"><strong>OpenGL ES Shading Language Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>1.00</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.00</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.10</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">
                  <code class="function">bitfieldExtract</code>
                </td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; border-right: 2px solid ; ">-</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p>
            <a class="citerefentry" href="bitfieldExtract.xhtml"><span class="citerefentry"><span class="refentrytitle">bitfieldExtract</span></span></a>
        </p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright <span class="trademark"/>© 2011-2016 Khronos Group. 
            This material may be distributed subject to the terms and conditions set forth in 
            the Open Publication License, v 1.0, 8 June 1999.
            <a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p>
      </div>
    </div>
    <footer/>
  </body>
</html>
